<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>EntityBatchHandler xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/org/sakaiproject/entitybus/rest/EntityBatchHandler.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: EntityBatchHandler.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-rest/xref/org/sakaiproject/entitybus/rest/EntityBatchHandler.html $</em>
<a name="4" href="#4">4</a>   <em> * EntityBatchHandler.java - entity-broker - Dec 18, 2008 11:40:39 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2.0</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski @ gmail.com) (aaronz @ vt.edu) (aaron @ caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.entitybus.<strong>rest</strong>;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.io.IOException;
<a name="18" href="#18">18</a>  <strong>import</strong> java.util.HashMap;
<a name="19" href="#19">19</a>  <strong>import</strong> java.util.HashSet;
<a name="20" href="#20">20</a>  <strong>import</strong> java.util.Map;
<a name="21" href="#21">21</a>  <strong>import</strong> java.util.Map.Entry;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> javax.servlet.http.Cookie;
<a name="24" href="#24">24</a>  <strong>import</strong> javax.servlet.http.HttpServletRequest;
<a name="25" href="#25">25</a>  <strong>import</strong> javax.servlet.http.HttpServletResponse;
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="29" href="#29">29</a>  <strong>import</strong> org.azeckoski.reflectutils.ArrayUtils;
<a name="30" href="#30">30</a>  <strong>import</strong> org.azeckoski.reflectutils.map.ArrayOrderedMap;
<a name="31" href="#31">31</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityBrokerManager;
<a name="32" href="#32">32</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityView;
<a name="33" href="#33">33</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.Formats;
<a name="34" href="#34">34</a>  <strong>import</strong> org.sakaiproject.entitybus.exception.EntityException;
<a name="35" href="#35">35</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityRequestHandler;
<a name="36" href="#36">36</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.EntityHttpServletRequest;
<a name="37" href="#37">37</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.EntityHttpServletResponse;
<a name="38" href="#38">38</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.HttpClientWrapper;
<a name="39" href="#39">39</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.HttpRESTUtils;
<a name="40" href="#40">40</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.HttpResponse;
<a name="41" href="#41">41</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.URLData;
<a name="42" href="#42">42</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.HttpRESTUtils.Method;
<a name="43" href="#43">43</a>  <strong>import</strong> org.sakaiproject.entitybus.util.request.RequestUtils;
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>  
<a name="46" href="#46">46</a>  <em>/**<em>*</em></em>
<a name="47" href="#47">47</a>  <em> * This handles batch operations internally as much as possible,</em>
<a name="48" href="#48">48</a>  <em> * the idea is to provide for a standard way to reduce huge numbers of calls down to 1 call to the server</em>
<a name="49" href="#49">49</a>  <em> * which puts the data together into a single response</em>
<a name="50" href="#50">50</a>  <em> * </em>
<a name="51" href="#51">51</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="52" href="#52">52</a>  <em> */</em>
<a name="53" href="#53">53</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBatchHandler.html">EntityBatchHandler</a> {
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String HEADER_BATCH_STATUS = <span class="string">"batchStatus"</span>;
<a name="56" href="#56">56</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String HEADER_BATCH_ERRORS = <span class="string">"batchErrors"</span>;
<a name="57" href="#57">57</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String HEADER_BATCH_MAPPING = <span class="string">"batchMapping"</span>;
<a name="58" href="#58">58</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String HEADER_BATCH_URLS = <span class="string">"batchURLs"</span>;
<a name="59" href="#59">59</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String HEADER_BATCH_REFS = <span class="string">"batchRefs"</span>;
<a name="60" href="#60">60</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String HEADER_BATCH_KEYS = <span class="string">"batchKeys"</span>;
<a name="61" href="#61">61</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String HEADER_BATCH_METHOD = <span class="string">"batchMethod"</span>;
<a name="62" href="#62">62</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String UNREFERENCED_PARAMS = <span class="string">"NoRefs"</span>;
<a name="63" href="#63">63</a>      <em>/**<em>*</em></em>
<a name="64" href="#64">64</a>  <em>     * This is the name of the parameter which is used to pass along the reference URLs to be batch processed</em>
<a name="65" href="#65">65</a>  <em>     */</em>
<a name="66" href="#66">66</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String REFS_PARAM_NAME = <span class="string">"_refs"</span>;
<a name="67" href="#67">67</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String UNIQUE_DATA_PREFIX = <span class="string">"X-XqReplaceQX-X-"</span>;
<a name="68" href="#68">68</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> Log log = LogFactory.getLog(EntityBatchHandler.<strong>class</strong>);
<a name="69" href="#69">69</a>      <strong>private</strong> <strong>static</strong> String INTERNAL_SERVER_ERROR_STATUS_STRING = HttpServletResponse.SC_INTERNAL_SERVER_ERROR+<span class="string">""</span>;
<a name="70" href="#70">70</a>  
<a name="71" href="#71">71</a>      <em>/**<em>*</em></em>
<a name="72" href="#72">72</a>  <em>     * Empty constructor, must use setters to set the needed services</em>
<a name="73" href="#73">73</a>  <em>     */</em>
<a name="74" href="#74">74</a>      <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBatchHandler.html">EntityBatchHandler</a>() { }
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>      <em>/**<em>*</em></em>
<a name="77" href="#77">77</a>  <em>     * Full constructor, use this to correctly construct this class,</em>
<a name="78" href="#78">78</a>  <em>     * note that after construction, the entityRequestHandler must be set also</em>
<a name="79" href="#79">79</a>  <em>     */</em>
<a name="80" href="#80">80</a>      <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBatchHandler.html">EntityBatchHandler</a>(EntityBrokerManager entityBrokerManager,
<a name="81" href="#81">81</a>              <a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a> entityEncodingManager) {
<a name="82" href="#82">82</a>          <strong>super</strong>();
<a name="83" href="#83">83</a>          <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="84" href="#84">84</a>          <strong>this</strong>.entityEncodingManager = entityEncodingManager;
<a name="85" href="#85">85</a>      }
<a name="86" href="#86">86</a>  
<a name="87" href="#87">87</a>      <strong>private</strong> EntityBrokerManager entityBrokerManager;
<a name="88" href="#88">88</a>      <strong>public</strong> <strong>void</strong> setEntityBrokerManager(EntityBrokerManager entityBrokerManager) {
<a name="89" href="#89">89</a>          <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="90" href="#90">90</a>      }
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>      <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a> entityEncodingManager;
<a name="93" href="#93">93</a>      <strong>public</strong> <strong>void</strong> setEntityEncodingManager(<a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a> entityEncodingManager) {
<a name="94" href="#94">94</a>          <strong>this</strong>.entityEncodingManager = entityEncodingManager;
<a name="95" href="#95">95</a>      }
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>      <em>/**<em>*</em></em>
<a name="98" href="#98">98</a>  <em>     * Can only set this after the class is constructed since it forms a circular dependency,</em>
<a name="99" href="#99">99</a>  <em>     * this is being set by the setter/constructor in the EntityHandlerImpl</em>
<a name="100" href="#100">100</a> <em>     */</em>
<a name="101" href="#101">101</a>     <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityHandlerImpl.html">EntityHandlerImpl</a> entityRequestHandler;
<a name="102" href="#102">102</a>     <strong>public</strong> <strong>void</strong> setEntityRequestHandler(<a href="../../../../org/sakaiproject/entitybus/rest/EntityHandlerImpl.html">EntityHandlerImpl</a> entityRequestHandler) {
<a name="103" href="#103">103</a>         <strong>this</strong>.entityRequestHandler = entityRequestHandler;
<a name="104" href="#104">104</a>     }
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>     <em class="comment">// allow the servlet name to be more flexible</em>
<a name="107" href="#107">107</a>     <strong>private</strong> String servletContext;
<a name="108" href="#108">108</a>     <strong>private</strong> String getServletContext() {
<a name="109" href="#109">109</a>         <strong>if</strong> (<strong>this</strong>.servletContext == <strong>null</strong>) {
<a name="110" href="#110">110</a>             setServletContext(<strong>null</strong>); <em class="comment">// set defaults</em>
<a name="111" href="#111">111</a>         }
<a name="112" href="#112">112</a>         <strong>return</strong> <strong>this</strong>.servletContext;
<a name="113" href="#113">113</a>     }
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>     <strong>public</strong> <strong>void</strong> setServletContext(String servletContext) {
<a name="116" href="#116">116</a>         <strong>if</strong> (servletContext == <strong>null</strong>) {
<a name="117" href="#117">117</a>             servletContext = RequestUtils.getServletContext(<strong>null</strong>);
<a name="118" href="#118">118</a>         }
<a name="119" href="#119">119</a>         <strong>this</strong>.servletContext = servletContext;
<a name="120" href="#120">120</a>         <strong>this</strong>.servletBatch = servletContext + EntityRequestHandler.SLASH_BATCH;
<a name="121" href="#121">121</a>     }
<a name="122" href="#122">122</a> 
<a name="123" href="#123">123</a>     <strong>private</strong> String servletBatch;
<a name="124" href="#124">124</a>     <strong>private</strong> String getServletBatch() {
<a name="125" href="#125">125</a>         <strong>if</strong> (<strong>this</strong>.servletBatch == <strong>null</strong>) {
<a name="126" href="#126">126</a>             setServletContext(<strong>null</strong>); <em class="comment">// set defaults</em>
<a name="127" href="#127">127</a>         }
<a name="128" href="#128">128</a>         <strong>return</strong> <strong>this</strong>.servletBatch;
<a name="129" href="#129">129</a>     }
<a name="130" href="#130">130</a> 
<a name="131" href="#131">131</a>     <em>/**<em>*</em></em>
<a name="132" href="#132">132</a> <em>     * Handle the batch operations encoded in this view and request</em>
<a name="133" href="#133">133</a> <em>     * @param view the current view</em>
<a name="134" href="#134">134</a> <em>     * @param req the current request</em>
<a name="135" href="#135">135</a> <em>     * @param res the current response</em>
<a name="136" href="#136">136</a> <em>     */</em>
<a name="137" href="#137">137</a>     <strong>public</strong> <strong>void</strong> handleBatch(EntityView view, HttpServletRequest req, HttpServletResponse res) {
<a name="138" href="#138">138</a>         <strong>if</strong> (view == <strong>null</strong> || req == <strong>null</strong> || res == <strong>null</strong>) {
<a name="139" href="#139">139</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not process batch: invalid arguments, no args can be null (view="</span>+view+<span class="string">",req="</span>+req+<span class="string">",res="</span>+res+<span class="string">")"</span>);
<a name="140" href="#140">140</a>         }
<a name="141" href="#141">141</a> 
<a name="142" href="#142">142</a>         <em class="comment">// set up the servlet context if this is the first time</em>
<a name="143" href="#143">143</a>         <strong>if</strong> (<strong>this</strong>.servletContext == <strong>null</strong>) {
<a name="144" href="#144">144</a>             setServletContext( RequestUtils.getServletContext(req) );
<a name="145" href="#145">145</a>         }
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a>         <em class="comment">// first find out which METHOD we are dealing with</em>
<a name="148" href="#148">148</a>         String reqMethod = req.getMethod() == <strong>null</strong> ? EntityView.Method.GET.name() : req.getMethod().toUpperCase().trim();
<a name="149" href="#149">149</a>         Method method = HttpRESTUtils.makeMethodFromString(reqMethod);
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a>         <strong>if</strong> (Method.GET.equals(method) 
<a name="152" href="#152">152</a>                 || Method.POST.equals(method)
<a name="153" href="#153">153</a>                 || Method.PUT.equals(method)
<a name="154" href="#154">154</a>                 || Method.DELETE.equals(method)) {
<a name="155" href="#155">155</a>             <em class="comment">// valid methods</em>
<a name="156" href="#156">156</a>             res.setHeader(HEADER_BATCH_METHOD, method.name());
<a name="157" href="#157">157</a>         } <strong>else</strong> {
<a name="158" href="#158">158</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot batch "</span>+reqMethod+<span class="string">" request method, cannot continue processing request: "</span> + view);
<a name="159" href="#159">159</a>         }
<a name="160" href="#160">160</a> 
<a name="161" href="#161">161</a>         <em class="comment">// now get to handling stuff</em>
<a name="162" href="#162">162</a>         String format = view.getFormat();
<a name="163" href="#163">163</a>         String servletContext = getServletContext(); <em class="comment">// will be the servlet context (e.g. /direct)</em>
<a name="164" href="#164">164</a> 
<a name="165" href="#165">165</a>         <em class="comment">// validate the the refs param</em>
<a name="166" href="#166">166</a>         String[] refs = getRefsOrFail(req);
<a name="167" href="#167">167</a> 
<a name="168" href="#168">168</a>         <em class="comment">// decode the params into a set of reference params</em>
<a name="169" href="#169">169</a>         Map&lt;String, Map&lt;String, String[]>> referencedParams = extractReferenceParams(req, method, refs);
<a name="170" href="#170">170</a> 
<a name="171" href="#171">171</a>         <em class="comment">// loop through all references</em>
<a name="172" href="#172">172</a>         HashSet&lt;String> processedRefsAndURLs = <strong>new</strong> HashSet&lt;String>(); <em class="comment">// holds all refs which we processed in this batch</em>
<a name="173" href="#173">173</a>         HashMap&lt;String, String> dataMap = <strong>new</strong> ArrayOrderedMap&lt;String, String>(); <em class="comment">// the returned content data from each ref</em>
<a name="174" href="#174">174</a>         Map&lt;String, ResponseBase> results = <strong>new</strong> ArrayOrderedMap&lt;String, ResponseBase>(); <em class="comment">// the results of all valid refs</em>
<a name="175" href="#175">175</a>         <strong>boolean</strong> successOverall = false; <em class="comment">// true if all ok or partial ok, false if exception occurs or all fail</em>
<a name="176" href="#176">176</a>         <strong>boolean</strong> failure = false;
<a name="177" href="#177">177</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; refs.length; i++) {
<a name="178" href="#178">178</a>             String refKey = <span class="string">"ref"</span> + i;
<a name="179" href="#179">179</a>             String reference = refs[i];
<a name="180" href="#180">180</a>             <em class="comment">// validate the reference is not blank</em>
<a name="181" href="#181">181</a>             <strong>if</strong> (reference == <strong>null</strong> || <span class="string">""</span>.equals(reference)) {
<a name="182" href="#182">182</a>                 <strong>continue</strong>; <em class="comment">// skip</em>
<a name="183" href="#183">183</a>             }
<a name="184" href="#184">184</a>             <em class="comment">// skip refs that are already done, we do not process twice unless it is a POST</em>
<a name="185" href="#185">185</a>             <em class="comment">// NOTE: this duplicate check happens again slightly down below so change both at once</em>
<a name="186" href="#186">186</a>             <strong>if</strong> (! Method.POST.equals(method) 
<a name="187" href="#187">187</a>                     &amp;&amp; processedRefsAndURLs.contains(reference)) {
<a name="188" href="#188">188</a>                 log.warn(<span class="string">"Found a duplicate reference, this will not be processed: "</span> + reference);
<a name="189" href="#189">189</a>                 <strong>continue</strong>; <em class="comment">// skip for GET/DELETE/PUT</em>
<a name="190" href="#190">190</a>             }
<a name="191" href="#191">191</a>             <em class="comment">// fix anything that does not start with a slash or http</em>
<a name="192" href="#192">192</a>             String entityURL = reference;
<a name="193" href="#193">193</a>             <strong>if</strong> (! reference.startsWith(<span class="string">"/"</span>) 
<a name="194" href="#194">194</a>                     &amp;&amp; ! reference.startsWith(<span class="string">"http://"</span>)) {
<a name="195" href="#195">195</a>                 <em class="comment">// assume this is an EB entity url without the slash</em>
<a name="196" href="#196">196</a>                 entityURL = servletContext + EntityView.SEPARATOR + reference;
<a name="197" href="#197">197</a>             }
<a name="198" href="#198">198</a>             <em class="comment">// make sure no one tries to batch a batch</em>
<a name="199" href="#199">199</a>             <strong>if</strong> (reference.startsWith(EntityRequestHandler.SLASH_BATCH)
<a name="200" href="#200">200</a>                     || reference.startsWith( getServletBatch() )) {
<a name="201" href="#201">201</a>                 <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Failure processing batch request, "</span>
<a name="202" href="#202">202</a>                         + <span class="string">"batch reference ("</span>+reference+<span class="string">") ("</span>+entityURL+<span class="string">") appears to be another "</span>
<a name="203" href="#203">203</a>                         + <span class="string">"batch URL (contains "</span>+EntityRequestHandler.SLASH_BATCH+<span class="string">"), "</span>
<a name="204" href="#204">204</a>                         + <span class="string">"failure in batch request: "</span> + view,
<a name="205" href="#205">205</a>                         EntityRequestHandler.SLASH_BATCH, 
<a name="206" href="#206">206</a>                         HttpServletResponse.SC_BAD_REQUEST);
<a name="207" href="#207">207</a>             }
<a name="208" href="#208">208</a> 
<a name="209" href="#209">209</a>             <em class="comment">// in case there are external ones we will reuse this httpclient</em>
<a name="210" href="#210">210</a>             HttpClientWrapper clientWrapper = <strong>null</strong>;
<a name="211" href="#211">211</a> 
<a name="212" href="#212">212</a>             <em class="comment">// object will hold the results of this reference request</em>
<a name="213" href="#213">213</a>             ResponseBase result = <strong>null</strong>;
<a name="214" href="#214">214</a> 
<a name="215" href="#215">215</a>             <em class="comment">// parse the entityURL, should hopefully not cause a failure</em>
<a name="216" href="#216">216</a>             URLData ud = <strong>new</strong> URLData(entityURL);
<a name="217" href="#217">217</a> 
<a name="218" href="#218">218</a>             <em class="comment">/*</em>
<a name="219" href="#219">219</a> <em class="comment">             * identify the EB direct operations - </em>
<a name="220" href="#220">220</a> <em class="comment">             * this allows us to strip extensions and cleanup direct URLs as needed,</em>
<a name="221" href="#221">221</a> <em class="comment">             * possibly also handle these specially later on if desired,</em>
<a name="222" href="#222">222</a> <em class="comment">             * only EB operations can be handled internally</em>
<a name="223" href="#223">223</a> <em class="comment">             */</em>
<a name="224" href="#224">224</a>             <strong>if</strong> ( servletContext.equals(ud.contextPath) ) {
<a name="225" href="#225">225</a>                 <strong>if</strong> (ud.pathInfo == <strong>null</strong> || <span class="string">""</span>.equals(ud.pathInfo)) {
<a name="226" href="#226">226</a>                     <em class="comment">// looks like this servlet only with no path and we do not process that</em>
<a name="227" href="#227">227</a>                     <strong>continue</strong>;
<a name="228" href="#228">228</a>                 }
<a name="229" href="#229">229</a> 
<a name="230" href="#230">230</a>                 <strong>boolean</strong> success = false;
<a name="231" href="#231">231</a>                 <strong>try</strong> {
<a name="232" href="#232">232</a>                     <em class="comment">// parse the entityURL to verify it</em>
<a name="233" href="#233">233</a>                     entityBrokerManager.parseReference(ud.pathInfo);
<a name="234" href="#234">234</a>                     success = <strong>true</strong>;
<a name="235" href="#235">235</a>                 } <strong>catch</strong> (IllegalArgumentException e) {
<a name="236" href="#236">236</a>                     String errorMessage = <span class="string">"Failure parsing direct entityURL ("</span>+entityURL+<span class="string">") from reference ("</span>+reference+<span class="string">") from path ("</span>+ud.pathInfo+<span class="string">"): "</span> + e.getMessage() + <span class="string">":"</span> + e.getCause();
<a name="237" href="#237">237</a>                     log.warn(errorMessage);
<a name="238" href="#238">238</a>                     result = <strong>new</strong> ResponseError(reference, entityURL, errorMessage);
<a name="239" href="#239">239</a>                 }
<a name="240" href="#240">240</a> 
<a name="241" href="#241">241</a>                 <strong>if</strong> (success) {
<a name="242" href="#242">242</a>                     <strong>if</strong> (Method.GET.equals(method)) {
<a name="243" href="#243">243</a>                         <em class="comment">// rebuild the entityURL with the correct extension in there for GET</em>
<a name="244" href="#244">244</a>                         StringBuilder sb = <strong>new</strong> StringBuilder();
<a name="245" href="#245">245</a>                         sb.append( servletContext );
<a name="246" href="#246">246</a>                         sb.append(ud.pathInfoNoExtension);
<a name="247" href="#247">247</a>                         sb.append(EntityView.PERIOD);
<a name="248" href="#248">248</a>                         sb.append(format);
<a name="249" href="#249">249</a>                         <strong>if</strong> (ud.query.length() > 0) {
<a name="250" href="#250">250</a>                             <em class="comment">// add on the query string</em>
<a name="251" href="#251">251</a>                             sb.append('?');
<a name="252" href="#252">252</a>                             sb.append(ud.query);
<a name="253" href="#253">253</a>                         }
<a name="254" href="#254">254</a>                         entityURL = sb.toString();
<a name="255" href="#255">255</a>                     }
<a name="256" href="#256">256</a> 
<a name="257" href="#257">257</a>                     <em class="comment">// skip URLs that are already done, we do not process twice unless it is a POST</em>
<a name="258" href="#258">258</a>                     <em class="comment">// NOTE: this duplicate check happens again slightly above so change both at once</em>
<a name="259" href="#259">259</a>                     <strong>if</strong> (! Method.POST.equals(method) 
<a name="260" href="#260">260</a>                             &amp;&amp; processedRefsAndURLs.contains(entityURL)) {
<a name="261" href="#261">261</a>                         log.warn(<span class="string">"Found a duplicate entityURL, this will not be processed: "</span> + entityURL);
<a name="262" href="#262">262</a>                         <strong>continue</strong>; <em class="comment">// skip</em>
<a name="263" href="#263">263</a>                     }
<a name="264" href="#264">264</a> 
<a name="265" href="#265">265</a>                     result = generateInternalResult(refKey, reference, entityURL, req, res, method, referencedParams);
<a name="266" href="#266">266</a>                 }
<a name="267" href="#267">267</a> 
<a name="268" href="#268">268</a>             } <strong>else</strong> {
<a name="269" href="#269">269</a>                 <em class="comment">// non-EB URL so we have to fire it off using the HttpUtils</em>
<a name="270" href="#270">270</a> 
<a name="271" href="#271">271</a>                 <em class="comment">// http utils requires full URLs</em>
<a name="272" href="#272">272</a>                 entityURL = makeFullExternalURL(req, entityURL);
<a name="273" href="#273">273</a> 
<a name="274" href="#274">274</a>                 <em class="comment">// set the client wrapper with cookies so we can reuse it for efficiency</em>
<a name="275" href="#275">275</a>                 <strong>if</strong> (clientWrapper == <strong>null</strong>) {
<a name="276" href="#276">276</a>                     clientWrapper = HttpRESTUtils.makeReusableHttpClient(false, 0, req.getCookies());
<a name="277" href="#277">277</a>                 }
<a name="278" href="#278">278</a>                 result = generateExternalResult(refKey, reference, entityURL, method, referencedParams, clientWrapper);
<a name="279" href="#279">279</a>             }
<a name="280" href="#280">280</a> 
<a name="281" href="#281">281</a>             <em class="comment">// special handling for null result (should really not happen unless there was a logic error)</em>
<a name="282" href="#282">282</a>             <strong>if</strong> (result == <strong>null</strong>) {
<a name="283" href="#283">283</a>                 successOverall = false;
<a name="284" href="#284">284</a>                 failure = <strong>true</strong>;
<a name="285" href="#285">285</a>                 <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Somehow the result is null, this should never happen, fatal error"</span>);
<a name="286" href="#286">286</a>             }
<a name="287" href="#287">287</a> 
<a name="288" href="#288">288</a>             <strong>if</strong> (result instanceof ResponseError) {
<a name="289" href="#289">289</a>                 <em class="comment">// looks like a failure occurred, keep going though</em>
<a name="290" href="#290">290</a>                 successOverall = false;
<a name="291" href="#291">291</a>                 failure = <strong>true</strong>;
<a name="292" href="#292">292</a>             } <strong>else</strong> {
<a name="293" href="#293">293</a>                 <em class="comment">// all ok, process data</em>
<a name="294" href="#294">294</a>                 <strong>int</strong> status = result.getStatus();
<a name="295" href="#295">295</a>                 <strong>if</strong> (status >= 200 &amp;&amp; status &lt; 300) {
<a name="296" href="#296">296</a>                     successOverall = <strong>true</strong>;
<a name="297" href="#297">297</a>                 }
<a name="298" href="#298">298</a>                 <strong>if</strong> (status == HttpServletResponse.SC_NO_CONTENT) {
<a name="299" href="#299">299</a>                     <em class="comment">// no content to process</em>
<a name="300" href="#300">300</a>                     ((ResponseResult)result).content = <strong>null</strong>;
<a name="301" href="#301">301</a>                     ((ResponseResult)result).data = <strong>null</strong>;
<a name="302" href="#302">302</a>                 } <strong>else</strong> {
<a name="303" href="#303">303</a>                     <em class="comment">// process the content and see if it matches the expected result, if not we have to dump it in escaped</em>
<a name="304" href="#304">304</a>                     String content = ((ResponseResult)result).content;
<a name="305" href="#305">305</a>                     String dataKey = checkContent(format, content, refKey, dataMap);
<a name="306" href="#306">306</a>                     ((ResponseResult)result).setDataKey(dataKey);
<a name="307" href="#307">307</a>                 }
<a name="308" href="#308">308</a>             }
<a name="309" href="#309">309</a> 
<a name="310" href="#310">310</a>             <em class="comment">// store the processed ref and url so we do not do them again</em>
<a name="311" href="#311">311</a>             processedRefsAndURLs.add(reference);
<a name="312" href="#312">312</a>             processedRefsAndURLs.add(entityURL);
<a name="313" href="#313">313</a>             results.put(refKey, result); <em class="comment">// use an artificial key</em>
<a name="314" href="#314">314</a>         }
<a name="315" href="#315">315</a> 
<a name="316" href="#316">316</a>         <em class="comment">// determine overall status</em>
<a name="317" href="#317">317</a>         <strong>int</strong> overallStatus = HttpServletResponse.SC_OK;
<a name="318" href="#318">318</a>         <strong>if</strong> (failure == <strong>true</strong> || successOverall == false) {
<a name="319" href="#319">319</a>             overallStatus = HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
<a name="320" href="#320">320</a>         }
<a name="321" href="#321">321</a> 
<a name="322" href="#322">322</a>         <em class="comment">// die if every ref was invalid</em>
<a name="323" href="#323">323</a>         <strong>if</strong> (results.size() == 0) {
<a name="324" href="#324">324</a>             <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Invalid request which resulted in no valid references to batch process, original _refs=("</span>
<a name="325" href="#325">325</a>                     +ArrayUtils.arrayToString(refs)+<span class="string">")"</span>, EntityRequestHandler.SLASH_BATCH, HttpServletResponse.SC_BAD_REQUEST);
<a name="326" href="#326">326</a>         }
<a name="327" href="#327">327</a> 
<a name="328" href="#328">328</a>         <em class="comment">// compile all the responses into encoded data</em>
<a name="329" href="#329">329</a>         String overallData = entityEncodingManager.encodeData(results, format, <span class="string">"refs"</span>, <strong>null</strong>);
<a name="330" href="#330">330</a>         <em class="comment">// replace the data unique keys if there are any</em>
<a name="331" href="#331">331</a>         overallData = reintegrateDataContent(format, dataMap, overallData);
<a name="332" href="#332">332</a> 
<a name="333" href="#333">333</a>         <em class="comment">// put response, headers, and code into the http response</em>
<a name="334" href="#334">334</a>         applyOverallHeaders(res, results);
<a name="335" href="#335">335</a>         <em class="comment">// put content into the response</em>
<a name="336" href="#336">336</a>         <strong>try</strong> {
<a name="337" href="#337">337</a>             res.getWriter().write(overallData);
<a name="338" href="#338">338</a>         } <strong>catch</strong> (IOException e) {
<a name="339" href="#339">339</a>             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Unable to encode data for overall response: "</span> + e.getMessage(), e);
<a name="340" href="#340">340</a>         }
<a name="341" href="#341">341</a>         <em class="comment">// set overall status code</em>
<a name="342" href="#342">342</a>         res.setStatus(overallStatus);
<a name="343" href="#343">343</a>     }
<a name="344" href="#344">344</a> 
<a name="345" href="#345">345</a>     <em>/**<em>*</em></em>
<a name="346" href="#346">346</a> <em>     * This will decode the set of params into a group of reference params based on the set of references</em>
<a name="347" href="#347">347</a> <em>     * @param req the current request</em>
<a name="348" href="#348">348</a> <em>     * @param method the current method</em>
<a name="349" href="#349">349</a> <em>     * @param refs the array of references</em>
<a name="350" href="#350">350</a> <em>     * @return the map of reference params with unreferenced params under the {@value #UNREFERENCED_PARAMS} key</em>
<a name="351" href="#351">351</a> <em>     * and everything else in ref# -> params map</em>
<a name="352" href="#352">352</a> <em>     */</em>
<a name="353" href="#353">353</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="354" href="#354">354</a>     <strong>private</strong> Map&lt;String, Map&lt;String, String[]>> extractReferenceParams(
<a name="355" href="#355">355</a>             HttpServletRequest req, Method method, String[] refs) {
<a name="356" href="#356">356</a>         <em class="comment">// Decode params into a reference map based on the refs for POST/PUT</em>
<a name="357" href="#357">357</a>         ArrayOrderedMap&lt;String, Map&lt;String, String[]>> referencedParams = <strong>null</strong>;
<a name="358" href="#358">358</a>         <strong>if</strong> (Method.POST.equals(method) || Method.PUT.equals(method) ) {
<a name="359" href="#359">359</a>             referencedParams = <strong>new</strong> ArrayOrderedMap&lt;String, Map&lt;String, String[]>>();
<a name="360" href="#360">360</a>             Map&lt;String, String[]> params = req.getParameterMap();
<a name="361" href="#361">361</a>             <em class="comment">// create the maps to hold the params</em>
<a name="362" href="#362">362</a>             referencedParams.put(UNREFERENCED_PARAMS, <strong>new</strong> ArrayOrderedMap&lt;String, String[]>(params.size()));
<a name="363" href="#363">363</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; refs.length; i++) {
<a name="364" href="#364">364</a>                 String refKey = <span class="string">"ref"</span> + i + '.';
<a name="365" href="#365">365</a>                 referencedParams.put(refKey, <strong>new</strong> ArrayOrderedMap&lt;String, String[]>(params.size()));
<a name="366" href="#366">366</a>             }
<a name="367" href="#367">367</a>             <em class="comment">// put all request params into the map</em>
<a name="368" href="#368">368</a>             <strong>for</strong> (Entry&lt;String, String[]> entry : params.entrySet()) {
<a name="369" href="#369">369</a>                 <strong>if</strong> (REFS_PARAM_NAME.equals(entry.getKey())) {
<a name="370" href="#370">370</a>                     <strong>continue</strong>; <em class="comment">// skip over the refs param</em>
<a name="371" href="#371">371</a>                 }
<a name="372" href="#372">372</a>                 <strong>boolean</strong> found = false;
<a name="373" href="#373">373</a>                 <strong>for</strong> (String refKey : referencedParams.keySet()) {
<a name="374" href="#374">374</a>                     <strong>if</strong> (entry.getKey().startsWith(refKey)) {
<a name="375" href="#375">375</a>                         String key = entry.getKey();
<a name="376" href="#376">376</a>                         <em class="comment">// fix key by removing the ref#. prefix</em>
<a name="377" href="#377">377</a>                         key = key.substring(refKey.length());
<a name="378" href="#378">378</a>                         <strong>if</strong> (key.length() == 0) {
<a name="379" href="#379">379</a>                             log.warn(<span class="string">"Skipping invalid reference param name ("</span>+entry.getKey()+<span class="string">"), "</span> +
<a name="380" href="#380">380</a>                             		<span class="string">"name must start with ref#. but MUST have the actual name of the param after that"</span>);
<a name="381" href="#381">381</a>                         } <strong>else</strong> {
<a name="382" href="#382">382</a>                             referencedParams.get(refKey).put(key, entry.getValue());
<a name="383" href="#383">383</a>                         }
<a name="384" href="#384">384</a>                         found = <strong>true</strong>;
<a name="385" href="#385">385</a>                         <strong>break</strong>;
<a name="386" href="#386">386</a>                     }
<a name="387" href="#387">387</a>                 }
<a name="388" href="#388">388</a>                 <strong>if</strong> (!found) {
<a name="389" href="#389">389</a>                     <em class="comment">// put the values into the unreferenced params portion of the map</em>
<a name="390" href="#390">390</a>                     referencedParams.get(UNREFERENCED_PARAMS).put(entry.getKey(), entry.getValue());
<a name="391" href="#391">391</a>                 }
<a name="392" href="#392">392</a>             }
<a name="393" href="#393">393</a>         }
<a name="394" href="#394">394</a>         <strong>return</strong> referencedParams;
<a name="395" href="#395">395</a>     }
<a name="396" href="#396">396</a> 
<a name="397" href="#397">397</a>     <em>/**<em>*</em></em>
<a name="398" href="#398">398</a> <em>     * Apply the headers to the batched response,</em>
<a name="399" href="#399">399</a> <em>     * these headers are applied to all responses</em>
<a name="400" href="#400">400</a> <em>     * @param res the response to apply headers to</em>
<a name="401" href="#401">401</a> <em>     * @param results the results of the requests</em>
<a name="402" href="#402">402</a> <em>     */</em>
<a name="403" href="#403">403</a>     <strong>private</strong> <strong>void</strong> applyOverallHeaders(HttpServletResponse res, Map&lt;String, ResponseBase> results) {
<a name="404" href="#404">404</a>         <em class="comment">// set overall headers - batchRefs, batchKeys, batchStatus, batchErrors, batchInvalidRefs</em>
<a name="405" href="#405">405</a>         <strong>int</strong> count = 0;
<a name="406" href="#406">406</a>         <strong>for</strong> (Entry&lt;String, ResponseBase> entry : results.entrySet()) {
<a name="407" href="#407">407</a>             String refKey = entry.getKey();
<a name="408" href="#408">408</a>             ResponseBase refResp = entry.getValue();
<a name="409" href="#409">409</a>             <strong>if</strong> (count == 0) {
<a name="410" href="#410">410</a>                 res.setHeader(HEADER_BATCH_KEYS, refKey);
<a name="411" href="#411">411</a>                 res.setHeader(HEADER_BATCH_REFS, refResp.getReference());
<a name="412" href="#412">412</a>                 res.setHeader(HEADER_BATCH_URLS, refResp.getEntityURL());
<a name="413" href="#413">413</a>                 res.setHeader(HEADER_BATCH_MAPPING, refKey + <span class="string">"="</span> + refResp.getReference());
<a name="414" href="#414">414</a>             } <strong>else</strong> {
<a name="415" href="#415">415</a>                 res.addHeader(HEADER_BATCH_KEYS, refKey);
<a name="416" href="#416">416</a>                 res.addHeader(HEADER_BATCH_REFS, refResp.getReference());
<a name="417" href="#417">417</a>                 res.addHeader(HEADER_BATCH_URLS, refResp.getEntityURL());
<a name="418" href="#418">418</a>                 res.addHeader(HEADER_BATCH_MAPPING, refKey + <span class="string">"="</span> + refResp.getReference());
<a name="419" href="#419">419</a>             }
<a name="420" href="#420">420</a>             <strong>if</strong> (refResp.isFailure()) {
<a name="421" href="#421">421</a>                 res.addHeader(HEADER_BATCH_ERRORS, refKey);
<a name="422" href="#422">422</a>                 res.addHeader(HEADER_BATCH_STATUS, INTERNAL_SERVER_ERROR_STATUS_STRING);
<a name="423" href="#423">423</a>             } <strong>else</strong> {
<a name="424" href="#424">424</a>                 <strong>int</strong> status = ((ResponseResult) refResp).getStatus();
<a name="425" href="#425">425</a>                 res.addHeader(HEADER_BATCH_STATUS, Integer.toString(status));
<a name="426" href="#426">426</a>             }
<a name="427" href="#427">427</a>             count++;
<a name="428" href="#428">428</a>         }
<a name="429" href="#429">429</a>     }
<a name="430" href="#430">430</a> 
<a name="431" href="#431">431</a> 
<a name="432" href="#432">432</a>     <em>/**<em>*</em></em>
<a name="433" href="#433">433</a> <em>     * Processing internal (EB) requests</em>
<a name="434" href="#434">434</a> <em>     * @return the result from the request (may be an error)</em>
<a name="435" href="#435">435</a> <em>     */</em>
<a name="436" href="#436">436</a>     <strong>private</strong> ResponseBase generateInternalResult(String refKey, String reference, String entityURL, HttpServletRequest req, 
<a name="437" href="#437">437</a>             HttpServletResponse res, Method method, Map&lt;String, Map&lt;String, String[]>> referencedParams) {
<a name="438" href="#438">438</a>         ResponseBase result = <strong>null</strong>;
<a name="439" href="#439">439</a>         ResponseError error = <strong>null</strong>;
<a name="440" href="#440">440</a> 
<a name="441" href="#441">441</a>         <em class="comment">/*<em class="comment"> WARNING: This is important to understand why this was done as is</em></em>
<a name="442" href="#442">442</a> <em class="comment">         * First of all, forget the servlet forwarding, it is hopeless.</em>
<a name="443" href="#443">443</a> <em class="comment">         * Why you ask? This is why, tomcat 5 has issues with calling forward using a set of custom</em>
<a name="444" href="#444">444</a> <em class="comment">         * httpservelet* objects, it REQUIRES objects that are tomcat objects and attempts to use and</em>
<a name="445" href="#445">445</a> <em class="comment">         * even cast to those objects. This causes 2 failures:</em>
<a name="446" href="#446">446</a> <em class="comment">         * 1) tomcat attempts to access specific attributes from the request which are not there in</em>
<a name="447" href="#447">447</a> <em class="comment">         * other request objects, thus it skips over processing the request entirely... without marking it as failed...</em>
<a name="448" href="#448">448</a> <em class="comment">         * 2) tomcat attempts to cast the response object to a tomcat object after most of the processing</em>
<a name="449" href="#449">449</a> <em class="comment">         * is complete and causes a ClassCastException which blows up everything</em>
<a name="450" href="#450">450</a> <em class="comment">         * </em>
<a name="451" href="#451">451</a> <em class="comment">         * The alternatives are using httpclient for everything (maybe not a bad plan)</em>
<a name="452" href="#452">452</a> <em class="comment">         * or calling the entity request handler directly, this has its own issues in that</em>
<a name="453" href="#453">453</a> <em class="comment">         * it actually causes problems with redirection and requires injecting things</em>
<a name="454" href="#454">454</a> <em class="comment">         * which depend on each other</em>
<a name="455" href="#455">455</a> <em class="comment">         * </em>
<a name="456" href="#456">456</a> <em class="comment">         * One last note on this, this all works fine in Jetty... tomcat fail</em>
<a name="457" href="#457">457</a> <em class="comment">         * Fun times for all</em>
<a name="458" href="#458">458</a> <em class="comment">         */</em>
<a name="459" href="#459">459</a> 
<a name="460" href="#460">460</a>         EntityHttpServletRequest entityRequest = <strong>new</strong> EntityHttpServletRequest(req, entityURL);
<a name="461" href="#461">461</a>         entityRequest.setContextPath(<span class="string">""</span>);
<a name="462" href="#462">462</a>         <strong>if</strong> (Method.POST.equals(method) || Method.PUT.equals(method) ) {
<a name="463" href="#463">463</a>             <em class="comment">// set only the unreferenced and correct referenced params for this request</em>
<a name="464" href="#464">464</a>             entityRequest.clearParameters(); <em class="comment">// also clears REFS_PARAM_NAME</em>
<a name="465" href="#465">465</a>             entityRequest.setParameters( referencedParams.get(UNREFERENCED_PARAMS) );
<a name="466" href="#466">466</a>             String key = refKey + '.';
<a name="467" href="#467">467</a>             <strong>if</strong> (referencedParams.containsKey(key)) {
<a name="468" href="#468">468</a>                 entityRequest.setParameters( referencedParams.get(key) );
<a name="469" href="#469">469</a>             }
<a name="470" href="#470">470</a>             <em class="comment">// set the params from the query itself again</em>
<a name="471" href="#471">471</a>             entityRequest.setParameters( entityRequest.pathQueryParams );
<a name="472" href="#472">472</a>             <em class="comment">//log.info("All request params: " + entityRequest.getStringParameters());</em>
<a name="473" href="#473">473</a>         } <strong>else</strong> {
<a name="474" href="#474">474</a>             entityRequest.removeParameter(REFS_PARAM_NAME); <em class="comment">// make sure this is not passed along</em>
<a name="475" href="#475">475</a>         }
<a name="476" href="#476">476</a>         entityRequest.setUseRealDispatcher(false); <em class="comment">// we do not want to actually have the container handle forwarding</em>
<a name="477" href="#477">477</a>         EntityHttpServletResponse entityResponse = <strong>new</strong> EntityHttpServletResponse(res);
<a name="478" href="#478">478</a> 
<a name="479" href="#479">479</a>         <strong>boolean</strong> redirected = false;
<a name="480" href="#480">480</a>         <strong>do</strong> {
<a name="481" href="#481">481</a>             <strong>try</strong> {
<a name="482" href="#482">482</a>                 entityRequestHandler.handleEntityAccess(entityRequest, entityResponse, <strong>null</strong>);
<a name="483" href="#483">483</a>                 redirected = false; <em class="comment">// assume no redirect</em>
<a name="484" href="#484">484</a>             } <strong>catch</strong> (Exception e) {
<a name="485" href="#485">485</a>                 String errorMessage = <span class="string">"Failure attempting to process reference ("</span>+reference+<span class="string">") for url ("</span>+entityURL+<span class="string">"): "</span> + e.getMessage() + <span class="string">":"</span> + e;
<a name="486" href="#486">486</a>                 log.warn(errorMessage, e);
<a name="487" href="#487">487</a>                 error = <strong>new</strong> ResponseError(reference, entityURL, errorMessage);
<a name="488" href="#488">488</a>                 <strong>break</strong>; <em class="comment">// take us out if there is a failure</em>
<a name="489" href="#489">489</a>             }
<a name="490" href="#490">490</a>             <em class="comment">// Must handle all redirects manually despite the annoyance - this is really crappy but oh well</em>
<a name="491" href="#491">491</a>             <strong>if</strong> (entityResponse.isRedirected()) {
<a name="492" href="#492">492</a>                 String redirectURL = entityResponse.getRedirectedUrl();
<a name="493" href="#493">493</a>                 <strong>if</strong> (redirectURL == <strong>null</strong> || redirectURL.length() == 0) {
<a name="494" href="#494">494</a>                     <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Failed to find redirect URL when redirect was indicated by status ("</span>+entityResponse.getStatus()+<span class="string">") for reference ("</span>+reference+<span class="string">")"</span>, reference);
<a name="495" href="#495">495</a>                 }
<a name="496" href="#496">496</a>                 entityURL = redirectURL;
<a name="497" href="#497">497</a>                 <em class="comment">// check that the redirect is not external</em>
<a name="498" href="#498">498</a>                 <strong>if</strong> ( entityURL.startsWith(servletContext) ) {
<a name="499" href="#499">499</a>                     <em class="comment">// internal</em>
<a name="500" href="#500">500</a>                     entityRequest.setPathString(redirectURL);
<a name="501" href="#501">501</a>                     entityResponse.reset();
<a name="502" href="#502">502</a>                     redirected = <strong>true</strong>;
<a name="503" href="#503">503</a>                 } <strong>else</strong> {
<a name="504" href="#504">504</a>                     <em class="comment">// TODO find a way to handle an external URL here</em>
<a name="505" href="#505">505</a>                     redirected = false;
<a name="506" href="#506">506</a>                 }
<a name="507" href="#507">507</a>             }
<a name="508" href="#508">508</a>         } <strong>while</strong> (redirected);
<a name="509" href="#509">509</a> 
<a name="510" href="#510">510</a>         <em>/**<em>* OLD CODE which can't work in tomcat 5</em></em>
<a name="511" href="#511">511</a> <em>        // setup the request and response objects to do the reference request</em>
<a name="512" href="#512">512</a> <em>        RequestDispatcher dispatcher = req.getRequestDispatcher(entityURL); // should only be the relative path from this webapp</em>
<a name="513" href="#513">513</a> <em>        // the request needs to get the full url or path though</em>
<a name="514" href="#514">514</a> <em>        EntityHttpServletRequest entityRequest = new EntityHttpServletRequest(req, req.getContextPath() + entityURL);</em>
<a name="515" href="#515">515</a> <em>        entityRequest.setContextPath("");</em>
<a name="516" href="#516">516</a> <em>        entityRequest.removeParameter(REFS_PARAM_NAME); // make sure this is not passed along</em>
<a name="517" href="#517">517</a> <em>        EntityHttpServletResponse entityResponse = new EntityHttpServletResponse(res);</em>
<a name="518" href="#518">518</a> 
<a name="519" href="#519">519</a> <em>        // fire off the URLs to the server and get back responses</em>
<a name="520" href="#520">520</a> <em>        try {</em>
<a name="521" href="#521">521</a> <em>            // need to forward instead of include to get headers back</em>
<a name="522" href="#522">522</a> <em>            dispatcher.forward(entityRequest, entityResponse);</em>
<a name="523" href="#523">523</a> <em>        } catch (Exception e) {</em>
<a name="524" href="#524">524</a> <em>            String errorMessage = "Failure attempting to process reference ("+reference+"): " + e.getMessage() + ":" + e;</em>
<a name="525" href="#525">525</a> <em>            log.warn(errorMessage, e);</em>
<a name="526" href="#526">526</a> <em>            error = new ResponseError(reference, entityURL, errorMessage);</em>
<a name="527" href="#527">527</a> <em>        }</em>
<a name="528" href="#528">528</a> <em>         **/</em>
<a name="529" href="#529">529</a> 
<a name="530" href="#530">530</a>         <em class="comment">// create the result object to encode and place into the final response</em>
<a name="531" href="#531">531</a>         <strong>if</strong> (error == <strong>null</strong>) {
<a name="532" href="#532">532</a>             <em class="comment">// all ok, create the result for the response object</em>
<a name="533" href="#533">533</a>             <em class="comment">// all cookies go into the main response</em>
<a name="534" href="#534">534</a>             Cookie[] cookies = entityResponse.getCookies();
<a name="535" href="#535">535</a>             <strong>for</strong> (Cookie cookie : cookies) {
<a name="536" href="#536">536</a>                 res.addCookie(cookie);
<a name="537" href="#537">537</a>             }
<a name="538" href="#538">538</a>             <em class="comment">// status codes are compiled</em>
<a name="539" href="#539">539</a>             <strong>int</strong> status = entityResponse.getStatus();
<a name="540" href="#540">540</a>             <em class="comment">// create the result (with raw content)</em>
<a name="541" href="#541">541</a>             result = <strong>new</strong> ResponseResult(reference, entityURL, status, entityResponse.getHeaders(), entityResponse.getContentAsString());
<a name="542" href="#542">542</a>         } <strong>else</strong> {
<a name="543" href="#543">543</a>             result = error;
<a name="544" href="#544">544</a>         }
<a name="545" href="#545">545</a>         <strong>return</strong> result;
<a name="546" href="#546">546</a>     }
<a name="547" href="#547">547</a> 
<a name="548" href="#548">548</a>     <em>/**<em>*</em></em>
<a name="549" href="#549">549</a> <em>     * Processing external (non-EB) requests</em>
<a name="550" href="#550">550</a> <em>     * @return the result from the request (may be an error)</em>
<a name="551" href="#551">551</a> <em>     */</em>
<a name="552" href="#552">552</a>     <strong>private</strong> ResponseBase generateExternalResult(String refKey, String reference, String entityURL, Method method, 
<a name="553" href="#553">553</a>             Map&lt;String, Map&lt;String, String[]>> referencedParams, HttpClientWrapper clientWrapper) {
<a name="554" href="#554">554</a>         ResponseBase result = <strong>null</strong>;
<a name="555" href="#555">555</a>         ResponseError error = <strong>null</strong>;
<a name="556" href="#556">556</a> 
<a name="557" href="#557">557</a>         <strong>boolean</strong> guaranteeSSL = false;
<a name="558" href="#558">558</a>         <em class="comment">// TODO allow enabling SSL?</em>
<a name="559" href="#559">559</a>         Map&lt;String, String> params = <strong>null</strong>;
<a name="560" href="#560">560</a>         <strong>if</strong> (referencedParams != <strong>null</strong> &amp;&amp; ! referencedParams.isEmpty()) {
<a name="561" href="#561">561</a>             params = <strong>new</strong> ArrayOrderedMap&lt;String, String>(referencedParams.size());
<a name="562" href="#562">562</a>             <em class="comment">// put all unreferenced params in</em>
<a name="563" href="#563">563</a>             Map&lt;String, String[]> urp = referencedParams.get(UNREFERENCED_PARAMS);
<a name="564" href="#564">564</a>             <strong>for</strong> (Entry&lt;String, String[]> entry : urp.entrySet()) {
<a name="565" href="#565">565</a>                 String name = entry.getKey();
<a name="566" href="#566">566</a>                 String value;
<a name="567" href="#567">567</a>                 <strong>if</strong> (entry.getValue() == <strong>null</strong> || entry.getValue().length == 0) {
<a name="568" href="#568">568</a>                     value = <span class="string">""</span>;
<a name="569" href="#569">569</a>                 } <strong>else</strong> {
<a name="570" href="#570">570</a>                     value = entry.getValue()[0];
<a name="571" href="#571">571</a>                 }
<a name="572" href="#572">572</a>                 params.put(name, value);
<a name="573" href="#573">573</a>             }
<a name="574" href="#574">574</a>             <strong>if</strong> (Method.POST.equals(method) || Method.PUT.equals(method) ) {
<a name="575" href="#575">575</a>                 <em class="comment">// put all referenced params in for this key</em>
<a name="576" href="#576">576</a>                 String key = refKey + '.';
<a name="577" href="#577">577</a>                 Map&lt;String, String[]> rp = referencedParams.get(key);
<a name="578" href="#578">578</a>                 <strong>if</strong> (rp != <strong>null</strong>) {
<a name="579" href="#579">579</a>                     <strong>for</strong> (Entry&lt;String, String[]> entry : rp.entrySet()) {
<a name="580" href="#580">580</a>                         String name = entry.getKey();
<a name="581" href="#581">581</a>                         String value;
<a name="582" href="#582">582</a>                         <strong>if</strong> (entry.getValue() == <strong>null</strong> || entry.getValue().length == 0) {
<a name="583" href="#583">583</a>                             value = <span class="string">""</span>;
<a name="584" href="#584">584</a>                         } <strong>else</strong> {
<a name="585" href="#585">585</a>                             value = entry.getValue()[0];
<a name="586" href="#586">586</a>                         }
<a name="587" href="#587">587</a>                         params.put(name, value);
<a name="588" href="#588">588</a>                     }
<a name="589" href="#589">589</a>                 }
<a name="590" href="#590">590</a>             }
<a name="591" href="#591">591</a>         }
<a name="592" href="#592">592</a>         <em class="comment">// fire off the request and hope it does not die horribly</em>
<a name="593" href="#593">593</a>         HttpResponse httpResponse = <strong>null</strong>;
<a name="594" href="#594">594</a>         <strong>try</strong> {
<a name="595" href="#595">595</a>             httpResponse = HttpRESTUtils.fireRequest(clientWrapper, 
<a name="596" href="#596">596</a>                     entityURL, 
<a name="597" href="#597">597</a>                     method,
<a name="598" href="#598">598</a>                     params, <strong>null</strong>, guaranteeSSL);
<a name="599" href="#599">599</a>         } <strong>catch</strong> (RuntimeException e) {
<a name="600" href="#600">600</a>             String errorMessage = <span class="string">"Failure attempting to process external URL ("</span>+entityURL+<span class="string">") from reference ("</span>+reference+<span class="string">"): "</span> + e.getMessage() + <span class="string">":"</span> + e;
<a name="601" href="#601">601</a>             log.warn(errorMessage); <em class="comment">//, e); // remove ,e to reduce error here</em>
<a name="602" href="#602">602</a>             error = <strong>new</strong> ResponseError(reference, entityURL, errorMessage);
<a name="603" href="#603">603</a>         }
<a name="604" href="#604">604</a> 
<a name="605" href="#605">605</a>         <em class="comment">// create the result object to encode and place into the final response</em>
<a name="606" href="#606">606</a>         <strong>if</strong> (error == <strong>null</strong>) {
<a name="607" href="#607">607</a>             result = <strong>new</strong> ResponseResult(reference, entityURL, httpResponse.getResponseCode(), 
<a name="608" href="#608">608</a>                     httpResponse.getResponseHeaders(), httpResponse.getResponseBody());
<a name="609" href="#609">609</a>         } <strong>else</strong> {
<a name="610" href="#610">610</a>             result = error;
<a name="611" href="#611">611</a>         }
<a name="612" href="#612">612</a>         <strong>return</strong> result;
<a name="613" href="#613">613</a>     }
<a name="614" href="#614">614</a> 
<a name="615" href="#615">615</a>     <em>/**<em>*</em></em>
<a name="616" href="#616">616</a> <em>     * Creates a full URL so that the request can be sent</em>
<a name="617" href="#617">617</a> <em>     * @param req the request</em>
<a name="618" href="#618">618</a> <em>     * @param entityURL the partial URL (e.g. /thing/blah)</em>
<a name="619" href="#619">619</a> <em>     * @return a full URL (e.g. <a href="http://server/thing/blah)" target="alexandria_uri">http://server/thing/blah)</a></em>
<a name="620" href="#620">620</a> <em>     */</em>
<a name="621" href="#621">621</a>     <strong>private</strong> String makeFullExternalURL(HttpServletRequest req, String entityURL) {
<a name="622" href="#622">622</a>         <strong>if</strong> (entityURL.startsWith(<span class="string">"/"</span>)) {
<a name="623" href="#623">623</a>             <em class="comment">// http client can only deal in complete URLs - e.g. "http://localhost:8080/thing"</em>
<a name="624" href="#624">624</a>             String serverName = req.getServerName();
<a name="625" href="#625">625</a>             <strong>int</strong> serverPort = req.getServerPort();
<a name="626" href="#626">626</a>             String protocol = req.getScheme();
<a name="627" href="#627">627</a>             <strong>if</strong> (protocol == <strong>null</strong> || <span class="string">""</span>.equals(protocol)) {
<a name="628" href="#628">628</a>                 protocol = <span class="string">"http"</span>;
<a name="629" href="#629">629</a>             }
<a name="630" href="#630">630</a>             StringBuilder sb = <strong>new</strong> StringBuilder(); <em class="comment">// the server URL</em>
<a name="631" href="#631">631</a>             sb.append(protocol);
<a name="632" href="#632">632</a>             sb.append(<span class="string">"://"</span>);
<a name="633" href="#633">633</a>             sb.append(serverName);
<a name="634" href="#634">634</a>             <strong>if</strong> (serverPort > 0) {
<a name="635" href="#635">635</a>                 sb.append(<span class="string">":"</span>);
<a name="636" href="#636">636</a>                 sb.append(serverPort);
<a name="637" href="#637">637</a>             }
<a name="638" href="#638">638</a>             <em class="comment">// look up the server URL using a service?</em>
<a name="639" href="#639">639</a>             entityURL = sb.toString() + entityURL;
<a name="640" href="#640">640</a>         }
<a name="641" href="#641">641</a>         <strong>return</strong> entityURL;
<a name="642" href="#642">642</a>     }
<a name="643" href="#643">643</a> 
<a name="644" href="#644">644</a>     <em>/**<em>*</em></em>
<a name="645" href="#645">645</a> <em>     * Gets the refs (batch URLs to handle) from the request if possible</em>
<a name="646" href="#646">646</a> <em>     * @param req the request</em>
<a name="647" href="#647">647</a> <em>     * @return the array of references</em>
<a name="648" href="#648">648</a> <em>     * @throws IllegalArgumentException if the refs canot be found</em>
<a name="649" href="#649">649</a> <em>     */</em>
<a name="650" href="#650">650</a>     <strong>private</strong> String[] getRefsOrFail(HttpServletRequest req) {
<a name="651" href="#651">651</a>         String[] refs = req.getParameterValues(REFS_PARAM_NAME);
<a name="652" href="#652">652</a>         <strong>if</strong> (refs == <strong>null</strong> || refs.length == 0) {
<a name="653" href="#653">653</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(REFS_PARAM_NAME + <span class="string">" parameter must be set (e.g. /direct/batch.json?"</span>+REFS_PARAM_NAME+<span class="string">"=/sites/popular,/sites/newest)"</span>);
<a name="654" href="#654">654</a>         }
<a name="655" href="#655">655</a>         <strong>if</strong> (refs.length == 1) {
<a name="656" href="#656">656</a>             <em class="comment">// process separated list, assume comma separated</em>
<a name="657" href="#657">657</a>             String separator = req.getParameter(<span class="string">"separator"</span>);
<a name="658" href="#658">658</a>             <strong>if</strong> (separator == <strong>null</strong> || <span class="string">""</span>.equals(separator)) {
<a name="659" href="#659">659</a>                 separator = <span class="string">","</span>;
<a name="660" href="#660">660</a>             }
<a name="661" href="#661">661</a>             String presplit = refs[0];
<a name="662" href="#662">662</a>             refs = presplit.split(separator);
<a name="663" href="#663">663</a>             <strong>if</strong> (refs == <strong>null</strong> || refs.length == 0) {
<a name="664" href="#664">664</a>                 <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Failure attempting to process the _refs ("</span>+presplit+<span class="string">") listing, could not get the final list of refs out by splitting using the separator ("</span>+separator+<span class="string">")"</span>);
<a name="665" href="#665">665</a>             }
<a name="666" href="#666">666</a>         }
<a name="667" href="#667">667</a>         <strong>if</strong> (refs.length &lt;= 0) {
<a name="668" href="#668">668</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(REFS_PARAM_NAME + <span class="string">" parameter must be set and there must be at least 1 reference (e.g. /direct/batch.json?"</span>+REFS_PARAM_NAME+<span class="string">"=/sites/popular,/sites/newest)"</span>);
<a name="669" href="#669">669</a>         }
<a name="670" href="#670">670</a>         <strong>return</strong> refs;
<a name="671" href="#671">671</a>     }
<a name="672" href="#672">672</a> 
<a name="673" href="#673">673</a>     <em>/**<em>*</em></em>
<a name="674" href="#674">674</a> <em>     * Takes the overall data and reintegrates any content data that is waiting to be merged,</em>
<a name="675" href="#675">675</a> <em>     * this may do nothing if there is no content to merge</em>
<a name="676" href="#676">676</a> <em>     * @return the integrated data content</em>
<a name="677" href="#677">677</a> <em>     */</em>
<a name="678" href="#678">678</a>     <strong>private</strong> String reintegrateDataContent(String format, HashMap&lt;String, String> dataMap,
<a name="679" href="#679">679</a>             String overallData) {
<a name="680" href="#680">680</a>         StringBuilder sb = <strong>new</strong> StringBuilder();
<a name="681" href="#681">681</a>         <strong>int</strong> curLoc = 0;
<a name="682" href="#682">682</a>         <strong>for</strong> (Entry&lt;String, String> entry : dataMap.entrySet()) {
<a name="683" href="#683">683</a>             <em class="comment">// looping order is critical here, it must be in the same order it was added</em>
<a name="684" href="#684">684</a>             <strong>if</strong> (entry.getKey() != <strong>null</strong> &amp;&amp; ! <span class="string">""</span>.equals(entry.getKey())) {
<a name="685" href="#685">685</a>                 String key = entry.getKey();
<a name="686" href="#686">686</a>                 String value = entry.getValue();
<a name="687" href="#687">687</a>                 <strong>if</strong> (Formats.XML.equals(format)) {
<a name="688" href="#688">688</a>                     value = <span class="string">"\n"</span> + value; <em class="comment">// add in a break</em>
<a name="689" href="#689">689</a>                 } <strong>else</strong> <strong>if</strong> (Formats.JSON.equals(format)) {
<a name="690" href="#690">690</a>                     key = '&quot;' + key + '&quot;'; <em class="comment">// have to also replace the quotes</em>
<a name="691" href="#691">691</a>                 }
<a name="692" href="#692">692</a>                 <strong>int</strong> keyLoc = overallData.indexOf(key);
<a name="693" href="#693">693</a>                 <strong>if</strong> (keyLoc > -1) {
<a name="694" href="#694">694</a>                     sb.append( overallData.subSequence(curLoc, keyLoc) );
<a name="695" href="#695">695</a>                     sb.append( value );
<a name="696" href="#696">696</a>                     curLoc = keyLoc + key.length();
<a name="697" href="#697">697</a>                 }
<a name="698" href="#698">698</a>                 <em class="comment">//overallData = overallData.replace(key, value);</em>
<a name="699" href="#699">699</a>             }
<a name="700" href="#700">700</a>         }
<a name="701" href="#701">701</a>         <em class="comment">// add in the remainder of the overall data string</em>
<a name="702" href="#702">702</a>         sb.append( overallData.subSequence(curLoc, overallData.length()) );
<a name="703" href="#703">703</a>         <strong>return</strong> sb.toString();
<a name="704" href="#704">704</a>     }
<a name="705" href="#705">705</a> 
<a name="706" href="#706">706</a>     <em>/**<em>*</em></em>
<a name="707" href="#707">707</a> <em>     * Checks that the content is in the correct format and is not too large,</em>
<a name="708" href="#708">708</a> <em>     * if it is too large it will not be processed and if it is in the wrong format it will be encoded as a data chunk,</em>
<a name="709" href="#709">709</a> <em>     * it is OK it will be placed into the dataMap and reintegrated after encoding</em>
<a name="710" href="#710">710</a> <em>     * @param content this it the content of the response body (if null then no processing occurs, null returned)</em>
<a name="711" href="#711">711</a> <em>     * @return the dataKey which maps to the real content, need replace the key later</em>
<a name="712" href="#712">712</a> <em>     */</em>
<a name="713" href="#713">713</a>     <strong>private</strong> String checkContent(String format, String content, String refKey,
<a name="714" href="#714">714</a>             HashMap&lt;String, String> dataMap) {
<a name="715" href="#715">715</a>         String dataKey = <strong>null</strong>;
<a name="716" href="#716">716</a>         <strong>if</strong> ( content != <strong>null</strong> &amp;&amp; ! <span class="string">""</span>.equals(content.trim()) ) {
<a name="717" href="#717">717</a>             <strong>if</strong> (entityEncodingManager.validateFormat(content, format)) {
<a name="718" href="#718">718</a>                 <em class="comment">// valid for the current format so insert later instead of merging now</em>
<a name="719" href="#719">719</a>                 dataKey = UNIQUE_DATA_PREFIX + refKey;
<a name="720" href="#720">720</a>                 dataMap.put(dataKey, content);
<a name="721" href="#721">721</a>             }
<a name="722" href="#722">722</a>         }
<a name="723" href="#723">723</a>         <strong>return</strong> dataKey;
<a name="724" href="#724">724</a>     }
<a name="725" href="#725">725</a> 
<a name="726" href="#726">726</a>     <em>/**<em>*</em></em>
<a name="727" href="#727">727</a> <em>     * Base class for all response data which will be encoded and output</em>
<a name="728" href="#728">728</a> <em>     */</em>
<a name="729" href="#729">729</a>     <strong>public</strong> <strong>static</strong> <strong>class</strong> ResponseBase {
<a name="730" href="#730">730</a>         <strong>public</strong> String reference;
<a name="731" href="#731">731</a>         <strong>public</strong> String getReference() {
<a name="732" href="#732">732</a>             <strong>return</strong> reference;
<a name="733" href="#733">733</a>         }
<a name="734" href="#734">734</a>         <strong>public</strong> String entityURL;
<a name="735" href="#735">735</a>         <strong>public</strong> String getEntityURL() {
<a name="736" href="#736">736</a>             <strong>return</strong> entityURL;
<a name="737" href="#737">737</a>         }
<a name="738" href="#738">738</a>         <strong>public</strong> <strong>int</strong> status;
<a name="739" href="#739">739</a>         <strong>public</strong> <strong>int</strong> getStatus() {
<a name="740" href="#740">740</a>             <strong>return</strong> status;
<a name="741" href="#741">741</a>         }
<a name="742" href="#742">742</a>         <strong>public</strong> <strong>transient</strong> <strong>boolean</strong> failure = false;
<a name="743" href="#743">743</a>         <strong>public</strong> <strong>boolean</strong> isFailure() {
<a name="744" href="#744">744</a>             <strong>return</strong> failure;
<a name="745" href="#745">745</a>         }
<a name="746" href="#746">746</a>     }
<a name="747" href="#747">747</a> 
<a name="748" href="#748">748</a>     <em>/**<em>*</em></em>
<a name="749" href="#749">749</a> <em>     * Holds the error values which will be encoded by the various EB utils</em>
<a name="750" href="#750">750</a> <em>     */</em>
<a name="751" href="#751">751</a>     <strong>public</strong> <strong>static</strong> <strong>class</strong> ResponseError <strong>extends</strong> ResponseBase {
<a name="752" href="#752">752</a>         <strong>public</strong> String error;
<a name="753" href="#753">753</a>         <strong>public</strong> ResponseError(String reference, String entityURL, String errorMessage) {
<a name="754" href="#754">754</a>             <strong>this</strong>.reference = reference;
<a name="755" href="#755">755</a>             <strong>this</strong>.entityURL = entityURL;
<a name="756" href="#756">756</a>             <strong>this</strong>.error = errorMessage;
<a name="757" href="#757">757</a>             <strong>this</strong>.failure = <strong>true</strong>;
<a name="758" href="#758">758</a>             <strong>this</strong>.status = HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
<a name="759" href="#759">759</a>         }
<a name="760" href="#760">760</a>     }
<a name="761" href="#761">761</a> 
<a name="762" href="#762">762</a>     <em>/**<em>*</em></em>
<a name="763" href="#763">763</a> <em>     * Holds the results from a successful response request</em>
<a name="764" href="#764">764</a> <em>     */</em>
<a name="765" href="#765">765</a>     <strong>public</strong> <strong>static</strong> <strong>class</strong> ResponseResult <strong>extends</strong> ResponseBase {
<a name="766" href="#766">766</a>         <strong>public</strong> Map&lt;String, String[]> headers;
<a name="767" href="#767">767</a>         <strong>public</strong> String data;
<a name="768" href="#768">768</a>         <em>/**<em>*</em></em>
<a name="769" href="#769">769</a> <em>         * Set the data key (clears the raw content) if the key is non-null</em>
<a name="770" href="#770">770</a> <em>         * @param data processed data</em>
<a name="771" href="#771">771</a> <em>         */</em>
<a name="772" href="#772">772</a>         <strong>public</strong> <strong>void</strong> setDataKey(String dataKey) {
<a name="773" href="#773">773</a>             <strong>if</strong> (dataKey != <strong>null</strong>) {
<a name="774" href="#774">774</a>                 <strong>this</strong>.data = dataKey;
<a name="775" href="#775">775</a>                 <strong>this</strong>.content = <strong>null</strong>;
<a name="776" href="#776">776</a>             }
<a name="777" href="#777">777</a>         }
<a name="778" href="#778">778</a>         <em>/**<em>*</em></em>
<a name="779" href="#779">779</a> <em>         * The raw content from the request</em>
<a name="780" href="#780">780</a> <em>         */</em>
<a name="781" href="#781">781</a>         <strong>public</strong> String content;
<a name="782" href="#782">782</a>         <strong>public</strong> ResponseResult(String reference, String entityURL, <strong>int</strong> status, Map&lt;String, String[]> headers) {
<a name="783" href="#783">783</a>             <strong>this</strong>.reference = reference;
<a name="784" href="#784">784</a>             <strong>this</strong>.entityURL = entityURL;
<a name="785" href="#785">785</a>             <strong>this</strong>.status = status;
<a name="786" href="#786">786</a>             <strong>this</strong>.headers = headers;
<a name="787" href="#787">787</a>             <strong>this</strong>.failure = false;
<a name="788" href="#788">788</a>             <strong>this</strong>.content = <strong>null</strong>;
<a name="789" href="#789">789</a>             <strong>this</strong>.data = <strong>null</strong>;
<a name="790" href="#790">790</a>         }
<a name="791" href="#791">791</a>         <strong>public</strong> ResponseResult(String reference, String entityURL, <strong>int</strong> status, Map&lt;String, String[]> headers, String content) {
<a name="792" href="#792">792</a>             <strong>this</strong>.reference = reference;
<a name="793" href="#793">793</a>             <strong>this</strong>.entityURL = entityURL;
<a name="794" href="#794">794</a>             <strong>this</strong>.status = status;
<a name="795" href="#795">795</a>             <strong>this</strong>.headers = headers;
<a name="796" href="#796">796</a>             <strong>this</strong>.content = content;
<a name="797" href="#797">797</a>             <strong>this</strong>.data = <strong>null</strong>;
<a name="798" href="#798">798</a>             <strong>this</strong>.failure = false;
<a name="799" href="#799">799</a>         }
<a name="800" href="#800">800</a>     }
<a name="801" href="#801">801</a> 
<a name="802" href="#802">802</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

